package com.example.apidocserver.domain.document.dao;

import com.example.apidocserver.domain.document.entity.ApiDocument;
import com.example.apidocserver.infrastructure.aop.QueryAnno;
import com.example.apidocserver.infrastructure.aop.UpsertAnno;
import org.apache.ibatis.annotations.Param;
import org.apache.ibatis.annotations.Mapper;

import java.util.List;

/**
 * (ApiDocument)表数据库访问层
 *
 * @author makejava
 * @since 2023-02-22 22:56:11
 */
@Mapper
public interface ApiDocumentDao {

    /**
     * 通过ID查询单条数据
     *
     * @param id 主键
     * @return 实例对象
     */
    @QueryAnno
    ApiDocument queryById(Integer id);

    /**
     * 查询指定行数据
     *
     * @return 对象列表
     */
    @QueryAnno
    List<ApiDocument> queryAll();

    /**
     * 查询指定行数据
     *
     * @param apiDocument 查询条件
     * @return 对象列表
     */
    @QueryAnno
    List<ApiDocument> queryByEntity(ApiDocument apiDocument);

    /**
     * 统计总行数
     *
     * @param apiDocument 查询条件
     * @return 总行数
     */
    long count(ApiDocument apiDocument);

    /**
     * 新增数据
     *
     * @param apiDocument 实例对象
     * @return 影响行数
     */
    @UpsertAnno(isInsert = true)
    int insert(ApiDocument apiDocument);

    /**
     * 新增数据非空使用数据库默认值
     *
     * @param apiDocument 实例对象
     * @return 影响行数
     */
    @UpsertAnno(isInsert = true)
    int insertSet(ApiDocument apiDocument);

    /**
     * 批量新增数据（MyBatis原生foreach方法）
     *
     * @param entities List<ApiDocument> 实例对象列表
     * @return 影响行数
     */
    @UpsertAnno(isInsert = true)
    int insertBatch(@Param("entities") List<ApiDocument> entities);

    /**
     * 批量新增或按主键更新数据（MyBatis原生foreach方法）
     *
     * @param entities List<ApiDocument> 实例对象列表
     * @return 影响行数
     * @throws org.springframework.jdbc.BadSqlGrammarException 入参是空List的时候会抛SQL语句错误的异常，请自行校验入参
     */
    @UpsertAnno(isInsert = true, upsert = true)
    int insertOrUpdateBatch(@Param("entities") List<ApiDocument> entities);

    /**
     * 修改数据
     *
     * @param apiDocument 实例对象
     * @return 影响行数
     */
    @UpsertAnno
    int update(ApiDocument apiDocument);

    /**
     * 通过主键删除数据
     *
     * @param id 主键
     * @return 影响行数
     */
    int deleteById(Integer id);

    /**
     * 查询
     *
     * @param spaceId 工作空间
     * @param enable  是否启用，0查询全部，1只查询启用
     * @param publish 是否公开，0查询全部，1只查询公开
     * @return 文档对象信息
     */
    @QueryAnno
    List<ApiDocument> queryBySpaceId(@Param("spaceId") Integer spaceId, @Param("enable") int enable, @Param("publish") int publish);
}

